Align agentic-retrieval-pipeline-example notebook with validated KB flow#187
Open
mattgotteiner wants to merge 1 commit into
Open
Align agentic-retrieval-pipeline-example notebook with validated KB flow#187mattgotteiner wants to merge 1 commit into
mattgotteiner wants to merge 1 commit into
Conversation
mattgotteiner
force-pushed
the
align-tutorial-kb-20260608
branch
from
0819b44 to
1e1492f
Compare
- Surface 'Knowledge Bases' and 'Foundry IQ' terminology in notebook title/description
- Add AzureKeyCredential support: optional AZURE_SEARCH_API_KEY and AZURE_OPENAI_API_KEY
- Add azure_openai_resource_endpoint() helper to normalize endpoint URLs
- Use search_credential throughout all Search SDK calls
- Add semantic_configuration_name and page_chunk field to knowledge source parameters
- Remove KnowledgeRetrievalOutputMode enum; use output_mode='extractiveData' string
- Fix MCP endpoint API version: 2025-11-01-Preview -> 2026-05-01-preview
- Add endpoint.rstrip('/') to MCP URL construction
- Add timeout=60 to requests.get for document download
- Fix extra_body key: 'agent_reference' -> 'agent' in responses.create
- Fix delete_index(index) -> delete_index(index_name) in cleanup cell
- Add optional AZURE_SEARCH_API_KEY and AZURE_OPENAI_API_KEY to sample.env
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
mattgotteiner
force-pushed
the
align-tutorial-kb-20260608
branch
from
1e1492f to
c36a157
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the
agentic-retrieval-pipeline-examplenotebook to align it with the validated MCP connection flow from end-to-end testing, and surfaces Knowledge Bases / Foundry IQ terminology consistently.Changes
agent-example.ipynbAzureKeyCredentialimport; addazure_openai_resource_endpoint()helper to normalize endpoint URLs; add optionalAZURE_SEARCH_API_KEY/AZURE_OPENAI_API_KEYsupport viasearch_credentialsearch_credential; pass optional API key toAzureOpenAIVectorizerParameterstimeout=60torequests.get; usesearch_credentialsemantic_configuration_name="semantic_config"; addpage_chunktosource_data_fields; usesearch_credentialKnowledgeRetrievalOutputModeenum import; useoutput_mode="extractiveData"string; fix MCP URL:2025-11-01-Preview->2026-05-01-preview; addendpoint.rstrip('/')extra_bodykey:"agent_reference"->"agent"search_credentialdelete_index(index)->delete_index(index_name)sample.envAdded commented-out optional entries for
AZURE_SEARCH_API_KEYandAZURE_OPENAI_API_KEY.Testing
Changes validated end-to-end against
magottei-s1mandmagottei-swedencentral-foundry/proj-default(seekr-build-sdk-investigation-20260516).